Feature/stim grammar #45
Open
+732
−243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This makes it easier to fill out the stimuli. This does mean, that a GroupList, does not only contain groups, but also elements of WhiteSpace, so the grammar becomes a bit less tidy...
bbonf
reviewed
Jan 24, 2025
| Previously, when the spr was presenting multiple words as one group/simultaneous, you | ||
| needed to separate them by inserting e.g. a `/`, as of now, you have to | ||
| specifically create groups yourself and grouping of words is always on. On | ||
| the. There are two kinds of groups `{{A group of words that is not recorded}}` |
| needed to separate them by inserting e.g. a `/`, as of now, you have to | ||
| specifically create groups yourself and grouping of words is always on. On | ||
| the. There are two kinds of groups `{{A group of words that is not recorded}}` | ||
| `{{#A group of words that is NOT recorded.}}`. Recorded means that the |
| output. You should not put word letters etc outside of a group. | ||
|
|
||
| All the words of your spr need to be enclosed in **{{**double curly braces**}}** | ||
| so the phrase "double curly braces" is presented together. If you want the to |
There was a problem hiding this comment.
wan the ... to (missing word)
| the stimulus into parts and to remove the `/` in the case described here. | ||
| In this example the spaces are embedded inside the groups, both methods are | ||
| fine, but the author finds the first method better readable. If you put | ||
| none white space characters outside of a group it will be considered a syntax error. |
There was a problem hiding this comment.
not sure I understand, maybe add an example?
| from the stimulus. So you should take in mind how the stimulus would appear | ||
| after the grouping string is removed. | ||
| However, the syntax for this is more strict than HTML, forgetting to close a bold | ||
| or italic tag will result in an error. The bold or you'll have to close the |
There was a problem hiding this comment.
The bold or ... you'll (missing word)
| advanceWhiteSpace(context, group); | ||
| } | ||
| else if (type == "Group") { | ||
| let parts = group.sentence_parts.parts; |
There was a problem hiding this comment.
it might be easier to follow if you also have an advanceGroup function
| } | ||
| ); | ||
|
|
||
| // for (let line = 0; line < lines.length; line++) { |
| parser.feed(stimulus) | ||
| let tree = parser.results | ||
| if (tree.length > 1) { | ||
| console.error("The grammar is ambigious for this stimulus"); |
There was a problem hiding this comment.
maybe this should throw an error instead?
| console.error("The grammar is ambigious for this stimulus"); | ||
| } | ||
| else if (tree.length == 0) { | ||
| console.log("stimulus: \"" + stimulus + |
| parser.feed(trial.stimulus) | ||
| let tree = parser.results | ||
| if (tree.length > 1) { | ||
| console.error("Oops, grammar is ambiguous."); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a feature reworks the way how stimuli are written for the jspsych-spr-reading. Using the javascript nearley parser and moo lexer frameworks it is possible to create a stimulus where you can be more confident how the stimulus will finaly appear on screen. The former stimulus was removing and replacing characters from the input along a number of dimension which made it hard to see what it was doing.
Now there a grammar that dictates how stimuli should be written see plugins/grammar.ne which is converted to plugins/grammar.js. This is all packaged using esbuild to the dist directory. you can call ./build.sh to recreate grammar.js and populate dist. with a packaged version of the plugin.
It is now easier to create a number of bold/italic words in a row as you can put multiple words within tags, whereas before you had to tag each individual word. The grammar is much stricter than a html parser, as groups need to be closed e.g see the readme for more details